<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.dailyprojectdata.server;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.FileInputStream;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.io.IOException;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Map;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.Properties;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.TreeMap;<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>    /**<a name="line.9"></a>
<FONT color="green">010</FONT>     * Provides access to the values stored in the dailyprojectdata.properties file. <a name="line.10"></a>
<FONT color="green">011</FONT>     * @author Philip Johnson<a name="line.11"></a>
<FONT color="green">012</FONT>     */<a name="line.12"></a>
<FONT color="green">013</FONT>    public class ServerProperties {<a name="line.13"></a>
<FONT color="green">014</FONT>      <a name="line.14"></a>
<FONT color="green">015</FONT>      /** The sensorbase fully qualified host name, such as http://localhost:9876/sensorbase. */<a name="line.15"></a>
<FONT color="green">016</FONT>      public static final String SENSORBASE_FULLHOST_KEY =  "dailyprojectdata.sensorbase.host";<a name="line.16"></a>
<FONT color="green">017</FONT>      /** The dailyprojectdata hostname key. */<a name="line.17"></a>
<FONT color="green">018</FONT>      public static final String HOSTNAME_KEY =        "dailyprojectdata.hostname";<a name="line.18"></a>
<FONT color="green">019</FONT>      /** The dailyprojectdata context root. */<a name="line.19"></a>
<FONT color="green">020</FONT>      public static final String CONTEXT_ROOT_KEY =     "dailyprojectdata.context.root";<a name="line.20"></a>
<FONT color="green">021</FONT>      /** The logging level key. */<a name="line.21"></a>
<FONT color="green">022</FONT>      public static final String LOGGING_LEVEL_KEY =   "dailyprojectdata.logging.level";<a name="line.22"></a>
<FONT color="green">023</FONT>      /** The dailyprojectdata port key. */<a name="line.23"></a>
<FONT color="green">024</FONT>      public static final String PORT_KEY =            "dailyprojectdata.port";<a name="line.24"></a>
<FONT color="green">025</FONT>      /** The XML directory key. */<a name="line.25"></a>
<FONT color="green">026</FONT>      public static final String XML_DIR_KEY =         "dailyprojectdata.xml.dir";<a name="line.26"></a>
<FONT color="green">027</FONT>      /** The Restlet Logging key. */<a name="line.27"></a>
<FONT color="green">028</FONT>      public static final String RESTLET_LOGGING_KEY = "dailyprojectdata.restlet.logging";<a name="line.28"></a>
<FONT color="green">029</FONT>      /** The dpd port key during testing. */<a name="line.29"></a>
<FONT color="green">030</FONT>      public static final String TEST_PORT_KEY =       "dailyprojectdata.test.port";<a name="line.30"></a>
<FONT color="green">031</FONT>      /** The test installation key. */<a name="line.31"></a>
<FONT color="green">032</FONT>      public static final String TEST_INSTALL_KEY =    "dailyprojectdata.test.install";<a name="line.32"></a>
<FONT color="green">033</FONT>      /** The test installation key. */<a name="line.33"></a>
<FONT color="green">034</FONT>      public static final String TEST_HOSTNAME_KEY =    "dailyprojectdata.test.hostname";<a name="line.34"></a>
<FONT color="green">035</FONT>      /** The test installation key. */<a name="line.35"></a>
<FONT color="green">036</FONT>      public static final String TEST_SENSORBASE_FULLHOST_KEY = "dailyprojectdata.test.sensorbase.host";<a name="line.36"></a>
<FONT color="green">037</FONT>      /** Indicates whether SensorBaseClient caching is enabled. */<a name="line.37"></a>
<FONT color="green">038</FONT>      public static final String CACHE_ENABLED = "dailyprojectdata.cache.enabled";<a name="line.38"></a>
<FONT color="green">039</FONT>      /** The maxLife in days for each instance in each SensorBaseClient cache. */<a name="line.39"></a>
<FONT color="green">040</FONT>      public static final String CACHE_MAX_LIFE = "dailyprojectdata.cache.max.life";<a name="line.40"></a>
<FONT color="green">041</FONT>      /** The total capacity of each SensorBaseClient cache. */<a name="line.41"></a>
<FONT color="green">042</FONT>      public static final String CACHE_CAPACITY = "dailyprojectdata.cache.capacity";<a name="line.42"></a>
<FONT color="green">043</FONT>      /** Whether or not the front side cache is enabled. */<a name="line.43"></a>
<FONT color="green">044</FONT>      public static final String FRONTSIDECACHE_ENABLED = "dailyprojectdata.cache.frontside.enabled";<a name="line.44"></a>
<FONT color="green">045</FONT>      <a name="line.45"></a>
<FONT color="green">046</FONT>      private String falseString = "false"; // for PMD.<a name="line.46"></a>
<FONT color="green">047</FONT>      <a name="line.47"></a>
<FONT color="green">048</FONT>      <a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>      /** Where we store the properties. */<a name="line.50"></a>
<FONT color="green">051</FONT>      private Properties properties; <a name="line.51"></a>
<FONT color="green">052</FONT>     <a name="line.52"></a>
<FONT color="green">053</FONT>      /**<a name="line.53"></a>
<FONT color="green">054</FONT>       * Creates a new ServerProperties instance. <a name="line.54"></a>
<FONT color="green">055</FONT>       * Prints an error to the console if problems occur on loading. <a name="line.55"></a>
<FONT color="green">056</FONT>       */<a name="line.56"></a>
<FONT color="green">057</FONT>      public ServerProperties() {<a name="line.57"></a>
<FONT color="green">058</FONT>        try {<a name="line.58"></a>
<FONT color="green">059</FONT>          initializeProperties();<a name="line.59"></a>
<FONT color="green">060</FONT>        }<a name="line.60"></a>
<FONT color="green">061</FONT>        catch (Exception e) {<a name="line.61"></a>
<FONT color="green">062</FONT>          System.out.println("Error initializing server properties: " + e.getMessage());<a name="line.62"></a>
<FONT color="green">063</FONT>        }<a name="line.63"></a>
<FONT color="green">064</FONT>      }<a name="line.64"></a>
<FONT color="green">065</FONT>      <a name="line.65"></a>
<FONT color="green">066</FONT>      /**<a name="line.66"></a>
<FONT color="green">067</FONT>       * Reads in the properties in ~/.hackystat/dailyprojectdata/dailyprojectdata.properties <a name="line.67"></a>
<FONT color="green">068</FONT>       * if this file exists, and provides default values for all properties.<a name="line.68"></a>
<FONT color="green">069</FONT>       * @throws Exception if errors occur.<a name="line.69"></a>
<FONT color="green">070</FONT>       */<a name="line.70"></a>
<FONT color="green">071</FONT>      private void initializeProperties () throws Exception {<a name="line.71"></a>
<FONT color="green">072</FONT>        String userHome = System.getProperty("user.home");<a name="line.72"></a>
<FONT color="green">073</FONT>        String userDir = System.getProperty("user.dir");<a name="line.73"></a>
<FONT color="green">074</FONT>        String propFile = userHome + "/.hackystat/dailyprojectdata/dailyprojectdata.properties";<a name="line.74"></a>
<FONT color="green">075</FONT>        this.properties = new Properties();<a name="line.75"></a>
<FONT color="green">076</FONT>        // Set defaults<a name="line.76"></a>
<FONT color="green">077</FONT>        properties.setProperty(SENSORBASE_FULLHOST_KEY, "http://localhost:9876/sensorbase/");<a name="line.77"></a>
<FONT color="green">078</FONT>        properties.setProperty(HOSTNAME_KEY, "localhost");<a name="line.78"></a>
<FONT color="green">079</FONT>        properties.setProperty(PORT_KEY, "9877");<a name="line.79"></a>
<FONT color="green">080</FONT>        properties.setProperty(CONTEXT_ROOT_KEY, "dailyprojectdata");<a name="line.80"></a>
<FONT color="green">081</FONT>        properties.setProperty(LOGGING_LEVEL_KEY, "INFO");<a name="line.81"></a>
<FONT color="green">082</FONT>        properties.setProperty(RESTLET_LOGGING_KEY, falseString);<a name="line.82"></a>
<FONT color="green">083</FONT>        properties.setProperty(XML_DIR_KEY, userDir + "/xml");<a name="line.83"></a>
<FONT color="green">084</FONT>        properties.setProperty(TEST_PORT_KEY, "9977");<a name="line.84"></a>
<FONT color="green">085</FONT>        properties.setProperty(TEST_HOSTNAME_KEY, "localhost");<a name="line.85"></a>
<FONT color="green">086</FONT>        properties.setProperty(TEST_SENSORBASE_FULLHOST_KEY, "http://localhost:9976/sensorbase");<a name="line.86"></a>
<FONT color="green">087</FONT>        properties.setProperty(TEST_INSTALL_KEY, falseString);<a name="line.87"></a>
<FONT color="green">088</FONT>        properties.setProperty(CACHE_ENABLED, "true");<a name="line.88"></a>
<FONT color="green">089</FONT>        properties.setProperty(FRONTSIDECACHE_ENABLED, "true");<a name="line.89"></a>
<FONT color="green">090</FONT>        properties.setProperty(CACHE_MAX_LIFE, "365");<a name="line.90"></a>
<FONT color="green">091</FONT>        properties.setProperty(CACHE_CAPACITY, "500000");<a name="line.91"></a>
<FONT color="green">092</FONT>        FileInputStream stream = null;<a name="line.92"></a>
<FONT color="green">093</FONT>        try {<a name="line.93"></a>
<FONT color="green">094</FONT>          stream = new FileInputStream(propFile);<a name="line.94"></a>
<FONT color="green">095</FONT>          System.out.println("Loading DailyProjectData properties from: " + propFile);<a name="line.95"></a>
<FONT color="green">096</FONT>          properties.load(stream);<a name="line.96"></a>
<FONT color="green">097</FONT>        }<a name="line.97"></a>
<FONT color="green">098</FONT>        catch (IOException e) {<a name="line.98"></a>
<FONT color="green">099</FONT>          System.out.println(propFile + " not found. Using default dailyprojectdata properties.");<a name="line.99"></a>
<FONT color="green">100</FONT>        }<a name="line.100"></a>
<FONT color="green">101</FONT>        finally {<a name="line.101"></a>
<FONT color="green">102</FONT>          if (stream != null) {<a name="line.102"></a>
<FONT color="green">103</FONT>            stream.close();<a name="line.103"></a>
<FONT color="green">104</FONT>          }<a name="line.104"></a>
<FONT color="green">105</FONT>        }<a name="line.105"></a>
<FONT color="green">106</FONT>        <a name="line.106"></a>
<FONT color="green">107</FONT>        trimProperties(properties);<a name="line.107"></a>
<FONT color="green">108</FONT>        // make sure that SENSORBASE_HOST always has a final slash.<a name="line.108"></a>
<FONT color="green">109</FONT>        String sensorBaseHost = (String) properties.get(SENSORBASE_FULLHOST_KEY);<a name="line.109"></a>
<FONT color="green">110</FONT>        if (!sensorBaseHost.endsWith("/")) {<a name="line.110"></a>
<FONT color="green">111</FONT>          properties.put(SENSORBASE_FULLHOST_KEY, sensorBaseHost + "/");<a name="line.111"></a>
<FONT color="green">112</FONT>        }<a name="line.112"></a>
<FONT color="green">113</FONT>      }<a name="line.113"></a>
<FONT color="green">114</FONT>      <a name="line.114"></a>
<FONT color="green">115</FONT>      /**<a name="line.115"></a>
<FONT color="green">116</FONT>       * Sets the following properties' values to their "test" equivalent.<a name="line.116"></a>
<FONT color="green">117</FONT>       * &lt;ul&gt;<a name="line.117"></a>
<FONT color="green">118</FONT>       * &lt;li&gt; HOSTNAME_KEY<a name="line.118"></a>
<FONT color="green">119</FONT>       * &lt;li&gt; PORT_KEY<a name="line.119"></a>
<FONT color="green">120</FONT>       * &lt;li&gt; SENSORBASE_FULLHOST_KEY<a name="line.120"></a>
<FONT color="green">121</FONT>       * &lt;/ul&gt;<a name="line.121"></a>
<FONT color="green">122</FONT>       * Also sets TEST_INSTALL_KEY's value to "true".<a name="line.122"></a>
<FONT color="green">123</FONT>       */<a name="line.123"></a>
<FONT color="green">124</FONT>      public void setTestProperties() {<a name="line.124"></a>
<FONT color="green">125</FONT>        properties.setProperty(HOSTNAME_KEY, properties.getProperty(TEST_HOSTNAME_KEY));<a name="line.125"></a>
<FONT color="green">126</FONT>        properties.setProperty(PORT_KEY, properties.getProperty(TEST_PORT_KEY));<a name="line.126"></a>
<FONT color="green">127</FONT>        properties.setProperty(SENSORBASE_FULLHOST_KEY, <a name="line.127"></a>
<FONT color="green">128</FONT>        properties.getProperty(TEST_SENSORBASE_FULLHOST_KEY));<a name="line.128"></a>
<FONT color="green">129</FONT>        properties.setProperty(TEST_INSTALL_KEY, "true");<a name="line.129"></a>
<FONT color="green">130</FONT>        properties.setProperty(CACHE_ENABLED, falseString);<a name="line.130"></a>
<FONT color="green">131</FONT>        properties.setProperty(FRONTSIDECACHE_ENABLED, falseString);<a name="line.131"></a>
<FONT color="green">132</FONT>        trimProperties(properties);<a name="line.132"></a>
<FONT color="green">133</FONT>      }<a name="line.133"></a>
<FONT color="green">134</FONT>      <a name="line.134"></a>
<FONT color="green">135</FONT>      /**<a name="line.135"></a>
<FONT color="green">136</FONT>       * Returns the value of the Server Property specified by the key.<a name="line.136"></a>
<FONT color="green">137</FONT>       * @param key Should be one of the public static final strings in this class.<a name="line.137"></a>
<FONT color="green">138</FONT>       * @return The value of the key, or null if not found.<a name="line.138"></a>
<FONT color="green">139</FONT>       */<a name="line.139"></a>
<FONT color="green">140</FONT>      public String get(String key) {<a name="line.140"></a>
<FONT color="green">141</FONT>        return this.properties.getProperty(key);<a name="line.141"></a>
<FONT color="green">142</FONT>      }<a name="line.142"></a>
<FONT color="green">143</FONT>      <a name="line.143"></a>
<FONT color="green">144</FONT>      /**<a name="line.144"></a>
<FONT color="green">145</FONT>       * Ensures that the there is no leading or trailing whitespace in the property values.<a name="line.145"></a>
<FONT color="green">146</FONT>       * The fact that we need to do this indicates a bug in Java's Properties implementation to me. <a name="line.146"></a>
<FONT color="green">147</FONT>       * @param properties The properties. <a name="line.147"></a>
<FONT color="green">148</FONT>       */<a name="line.148"></a>
<FONT color="green">149</FONT>      private void trimProperties(Properties properties) {<a name="line.149"></a>
<FONT color="green">150</FONT>        // Have to do this iteration in a Java 5 compatible manner. no stringPropertyNames().<a name="line.150"></a>
<FONT color="green">151</FONT>        for (Map.Entry&lt;Object, Object&gt; entry : properties.entrySet()) {<a name="line.151"></a>
<FONT color="green">152</FONT>          String propName = (String)entry.getKey();<a name="line.152"></a>
<FONT color="green">153</FONT>          properties.setProperty(propName, properties.getProperty(propName).trim());<a name="line.153"></a>
<FONT color="green">154</FONT>        }<a name="line.154"></a>
<FONT color="green">155</FONT>      }<a name="line.155"></a>
<FONT color="green">156</FONT>      <a name="line.156"></a>
<FONT color="green">157</FONT>      /**<a name="line.157"></a>
<FONT color="green">158</FONT>       * Returns the fully qualified host name, such as "http://localhost:9877/dailyprojectdata/".<a name="line.158"></a>
<FONT color="green">159</FONT>       * @return The fully qualified host name.<a name="line.159"></a>
<FONT color="green">160</FONT>       */<a name="line.160"></a>
<FONT color="green">161</FONT>      public String getFullHost() {<a name="line.161"></a>
<FONT color="green">162</FONT>        return "http://" + get(HOSTNAME_KEY) + ":" + get(PORT_KEY) + "/" + get(CONTEXT_ROOT_KEY) + "/";<a name="line.162"></a>
<FONT color="green">163</FONT>      }<a name="line.163"></a>
<FONT color="green">164</FONT>      <a name="line.164"></a>
<FONT color="green">165</FONT>      /**<a name="line.165"></a>
<FONT color="green">166</FONT>       * Returns true if caching is enabled in this service. <a name="line.166"></a>
<FONT color="green">167</FONT>       * @return True if caching enabled.<a name="line.167"></a>
<FONT color="green">168</FONT>       */<a name="line.168"></a>
<FONT color="green">169</FONT>      public boolean isCacheEnabled() {<a name="line.169"></a>
<FONT color="green">170</FONT>        return "True".equalsIgnoreCase(this.properties.getProperty(CACHE_ENABLED));<a name="line.170"></a>
<FONT color="green">171</FONT>      }<a name="line.171"></a>
<FONT color="green">172</FONT>      <a name="line.172"></a>
<FONT color="green">173</FONT>      /**<a name="line.173"></a>
<FONT color="green">174</FONT>       * Returns true if front side caching is enabled in this service. <a name="line.174"></a>
<FONT color="green">175</FONT>       * @return True if caching enabled.<a name="line.175"></a>
<FONT color="green">176</FONT>       */<a name="line.176"></a>
<FONT color="green">177</FONT>      public boolean isFrontSideCacheEnabled() {<a name="line.177"></a>
<FONT color="green">178</FONT>        return "True".equalsIgnoreCase(this.properties.getProperty(FRONTSIDECACHE_ENABLED));<a name="line.178"></a>
<FONT color="green">179</FONT>      }<a name="line.179"></a>
<FONT color="green">180</FONT>      <a name="line.180"></a>
<FONT color="green">181</FONT>      /**<a name="line.181"></a>
<FONT color="green">182</FONT>       * Returns the caching max life as a double.<a name="line.182"></a>
<FONT color="green">183</FONT>       * If the property has an illegal value, then return the default. <a name="line.183"></a>
<FONT color="green">184</FONT>       * @return The max life of each instance in the cache.<a name="line.184"></a>
<FONT color="green">185</FONT>       */<a name="line.185"></a>
<FONT color="green">186</FONT>      public double getCacheMaxLife() {<a name="line.186"></a>
<FONT color="green">187</FONT>        String maxLifeString = this.properties.getProperty(CACHE_MAX_LIFE);<a name="line.187"></a>
<FONT color="green">188</FONT>        double maxLife = 0;<a name="line.188"></a>
<FONT color="green">189</FONT>        try {<a name="line.189"></a>
<FONT color="green">190</FONT>          maxLife = Double.valueOf(maxLifeString);<a name="line.190"></a>
<FONT color="green">191</FONT>        }<a name="line.191"></a>
<FONT color="green">192</FONT>        catch (Exception e) {<a name="line.192"></a>
<FONT color="green">193</FONT>          System.out.println("Illegal cache max life: " + maxLifeString + ". Using default.");<a name="line.193"></a>
<FONT color="green">194</FONT>          maxLife = 365D;<a name="line.194"></a>
<FONT color="green">195</FONT>        }<a name="line.195"></a>
<FONT color="green">196</FONT>        return maxLife;<a name="line.196"></a>
<FONT color="green">197</FONT>      }<a name="line.197"></a>
<FONT color="green">198</FONT>      <a name="line.198"></a>
<FONT color="green">199</FONT>      /**<a name="line.199"></a>
<FONT color="green">200</FONT>       * Returns the in-memory capacity for each cache.<a name="line.200"></a>
<FONT color="green">201</FONT>       * If the property has an illegal value, then return the default. <a name="line.201"></a>
<FONT color="green">202</FONT>       * @return The in-memory capacity.<a name="line.202"></a>
<FONT color="green">203</FONT>       */<a name="line.203"></a>
<FONT color="green">204</FONT>      public long getCacheCapacity() {<a name="line.204"></a>
<FONT color="green">205</FONT>        String capacityString = this.properties.getProperty(CACHE_CAPACITY);<a name="line.205"></a>
<FONT color="green">206</FONT>        long capacity = 0;<a name="line.206"></a>
<FONT color="green">207</FONT>        try {<a name="line.207"></a>
<FONT color="green">208</FONT>          capacity = Long.valueOf(capacityString);<a name="line.208"></a>
<FONT color="green">209</FONT>        }<a name="line.209"></a>
<FONT color="green">210</FONT>        catch (Exception e) {<a name="line.210"></a>
<FONT color="green">211</FONT>          System.out.println("Illegal cache capacity: " + capacityString + ". Using default.");<a name="line.211"></a>
<FONT color="green">212</FONT>          capacity = 500000L;<a name="line.212"></a>
<FONT color="green">213</FONT>        }<a name="line.213"></a>
<FONT color="green">214</FONT>        return capacity;<a name="line.214"></a>
<FONT color="green">215</FONT>      }<a name="line.215"></a>
<FONT color="green">216</FONT>      <a name="line.216"></a>
<FONT color="green">217</FONT>      /**<a name="line.217"></a>
<FONT color="green">218</FONT>       * Returns a string containing all current properties in alphabetical order.<a name="line.218"></a>
<FONT color="green">219</FONT>       * @return A string with the properties.  <a name="line.219"></a>
<FONT color="green">220</FONT>       */<a name="line.220"></a>
<FONT color="green">221</FONT>      public String echoProperties() {<a name="line.221"></a>
<FONT color="green">222</FONT>        String cr = System.getProperty("line.separator"); <a name="line.222"></a>
<FONT color="green">223</FONT>        String eq = " = ";<a name="line.223"></a>
<FONT color="green">224</FONT>        String pad = "                ";<a name="line.224"></a>
<FONT color="green">225</FONT>        // Adding them to a treemap has the effect of alphabetizing them. <a name="line.225"></a>
<FONT color="green">226</FONT>        TreeMap&lt;String, String&gt; alphaProps = new TreeMap&lt;String, String&gt;();<a name="line.226"></a>
<FONT color="green">227</FONT>        for (Map.Entry&lt;Object, Object&gt; entry : this.properties.entrySet()) {<a name="line.227"></a>
<FONT color="green">228</FONT>          String propName = (String)entry.getKey();<a name="line.228"></a>
<FONT color="green">229</FONT>          String propValue = (String)entry.getValue();<a name="line.229"></a>
<FONT color="green">230</FONT>          alphaProps.put(propName, propValue);<a name="line.230"></a>
<FONT color="green">231</FONT>        }<a name="line.231"></a>
<FONT color="green">232</FONT>        StringBuffer buff = new StringBuffer(30);<a name="line.232"></a>
<FONT color="green">233</FONT>        buff.append("DailyProjectData Properties:").append(cr);<a name="line.233"></a>
<FONT color="green">234</FONT>        for (String key : alphaProps.keySet()) {<a name="line.234"></a>
<FONT color="green">235</FONT>          buff.append(pad).append(key).append(eq).append(get(key)).append(cr);<a name="line.235"></a>
<FONT color="green">236</FONT>        }<a name="line.236"></a>
<FONT color="green">237</FONT>        return buff.toString();<a name="line.237"></a>
<FONT color="green">238</FONT>      }<a name="line.238"></a>
<FONT color="green">239</FONT>    <a name="line.239"></a>
<FONT color="green">240</FONT>    }<a name="line.240"></a>




























































</PRE>
</BODY>
</HTML>
